# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.

defmodule GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Resources_BiddingStrategy do
  @moduledoc """
  A bidding strategy.

  ## Attributes

  *   `campaignCount` (*type:* `String.t`, *default:* `nil`) - Output only. The number of campaigns attached to this bidding strategy. This field is read-only.
  *   `currencyCode` (*type:* `String.t`, *default:* `nil`) - Immutable. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this currency can be set on creation and defaults to the manager customer's currency. For serving customers, this field cannot be set; all strategies in a serving customer implicitly use the serving customer's currency. In all cases the effective_currency_code field returns the currency used by the strategy.
  *   `effectiveCurrencyCode` (*type:* `String.t`, *default:* `nil`) - Output only. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this is the currency set by the advertiser when creating the strategy. For serving customers, this is the customer's currency_code. Bidding strategy metrics are reported in this currency. This field is read-only.
  *   `enhancedCpc` (*type:* `GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_EnhancedCpc.t`, *default:* `nil`) - A bidding strategy that raises bids for clicks that seem more likely to lead to a conversion and lowers them for clicks where they seem less likely.
  *   `id` (*type:* `String.t`, *default:* `nil`) - Output only. The ID of the bidding strategy.
  *   `maximizeConversionValue` (*type:* `GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_MaximizeConversionValue.t`, *default:* `nil`) - An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.
  *   `maximizeConversions` (*type:* `GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_MaximizeConversions.t`, *default:* `nil`) - An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.
  *   `name` (*type:* `String.t`, *default:* `nil`) - The name of the bidding strategy. All bidding strategies within an account must be named distinctly. The length of this string should be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed).
  *   `nonRemovedCampaignCount` (*type:* `String.t`, *default:* `nil`) - Output only. The number of non-removed campaigns attached to this bidding strategy. This field is read-only.
  *   `resourceName` (*type:* `String.t`, *default:* `nil`) - Immutable. The resource name of the bidding strategy. Bidding strategy resource names have the form: `customers/{customer_id}/biddingStrategies/{bidding_strategy_id}`
  *   `status` (*type:* `String.t`, *default:* `nil`) - Output only. The status of the bidding strategy. This field is read-only.
  *   `targetCpa` (*type:* `GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_TargetCpa.t`, *default:* `nil`) - A bidding strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
  *   `targetImpressionShare` (*type:* `GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_TargetImpressionShare.t`, *default:* `nil`) - A bidding strategy that automatically optimizes towards a chosen percentage of impressions.
  *   `targetOutrankShare` (*type:* `GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_TargetOutrankShare.t`, *default:* `nil`) - A bidding strategy that sets bids based on the target fraction of auctions where the advertiser should outrank a specific competitor. This field is deprecated. Creating a new bidding strategy with this field or attaching bidding strategies with this field to a campaign will fail. Mutates to strategies that already have this scheme populated are allowed.
  *   `targetRoas` (*type:* `GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_TargetRoas.t`, *default:* `nil`) - A bidding strategy that helps you maximize revenue while averaging a specific target Return On Ad Spend (ROAS).
  *   `targetSpend` (*type:* `GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_TargetSpend.t`, *default:* `nil`) - A bid strategy that sets your bids to help get as many clicks as possible within your budget.
  *   `type` (*type:* `String.t`, *default:* `nil`) - Output only. The type of the bidding strategy. Create a bidding strategy by setting the bidding scheme. This field is read-only.
  """

  use GoogleApi.Gax.ModelBase

  @type t :: %__MODULE__{
          :campaignCount => String.t() | nil,
          :currencyCode => String.t() | nil,
          :effectiveCurrencyCode => String.t() | nil,
          :enhancedCpc =>
            GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_EnhancedCpc.t() | nil,
          :id => String.t() | nil,
          :maximizeConversionValue =>
            GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_MaximizeConversionValue.t()
            | nil,
          :maximizeConversions =>
            GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_MaximizeConversions.t()
            | nil,
          :name => String.t() | nil,
          :nonRemovedCampaignCount => String.t() | nil,
          :resourceName => String.t() | nil,
          :status => String.t() | nil,
          :targetCpa =>
            GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_TargetCpa.t() | nil,
          :targetImpressionShare =>
            GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_TargetImpressionShare.t()
            | nil,
          :targetOutrankShare =>
            GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_TargetOutrankShare.t()
            | nil,
          :targetRoas =>
            GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_TargetRoas.t() | nil,
          :targetSpend =>
            GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_TargetSpend.t() | nil,
          :type => String.t() | nil
        }

  field(:campaignCount)
  field(:currencyCode)
  field(:effectiveCurrencyCode)

  field(:enhancedCpc,
    as: GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_EnhancedCpc
  )

  field(:id)

  field(:maximizeConversionValue,
    as: GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_MaximizeConversionValue
  )

  field(:maximizeConversions,
    as: GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_MaximizeConversions
  )

  field(:name)
  field(:nonRemovedCampaignCount)
  field(:resourceName)
  field(:status)
  field(:targetCpa, as: GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_TargetCpa)

  field(:targetImpressionShare,
    as: GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_TargetImpressionShare
  )

  field(:targetOutrankShare,
    as: GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_TargetOutrankShare
  )

  field(:targetRoas, as: GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_TargetRoas)

  field(:targetSpend,
    as: GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Common_TargetSpend
  )

  field(:type)
end

defimpl Poison.Decoder,
  for: GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Resources_BiddingStrategy do
  def decode(value, options) do
    GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Resources_BiddingStrategy.decode(
      value,
      options
    )
  end
end

defimpl Poison.Encoder,
  for: GoogleApi.SearchAds360.V0.Model.GoogleAdsSearchads360V0Resources_BiddingStrategy do
  def encode(value, options) do
    GoogleApi.Gax.ModelBase.encode(value, options)
  end
end
